cs-visual-time-sapi-v2
📘 API Documentation - cs-visual-time-sapi-v2
This section describes the attributes and usage of the cs-visual-time-sapi-v2 API Service.
💂️ Base Information
- API Title: cs-visual-time-sapi-v2
- Version: v1
- Base URL:
https://cs-visual-time-sapi-{env}-v2.us-e1.cloudhub.io/api/
Replace{env}
with:dev
(Development)qa
(Quality Assurance)prod
(Production)
🔑 Authentication
Required Headers
Header | Type | Description |
---|---|---|
Authorization | String | Bearer token in the format Bearer {{API_KEY}} |
client_id | String | Unique identifier for API clients |
- Authorization
- Length: 36 - 37 characters
- Example:
Bearer abcdefghijklmnopqrstuvwxyz1234567890
- client_id
- Length: 32 - 36 characters
- Example:
123e4567-e89b-12d3-a456-426614174000
📌 These headers are required in all requests.
Query Parameters
Parameter | Type | Required | Description |
---|---|---|---|
productId | String | ✅ | Product ID |
policyId | String | ✅ | Policy ID |
toIssue | Boolean | ✅ | True = Issue, False = Release |
Response Body
Returns policy status and issuance data.
📊 Common Parameters
Parameter | Type | Description | Required |
---|---|---|---|
client_id | String | API client identifier | ✅ |
Authorization | String | Bearer token for authentication | ✅ |
🔐 Security Schemes
Client ID Enforcement
Field | Type | Required | Length | Regex |
---|---|---|---|---|
client_id | String | Yes | 32 - 36 | [a-zA-Z0-9] |
client_secret | String | Yes | 32 - 64 | [a-zA-Z0-9] |
OAuth 2.0
Field | Type | Required | Length | Regex |
---|---|---|---|---|
Authorization | String | Yes | 36 - 37 | [a-zA-Z0-9-_.] |
⚠️ Error Codes
Code | Description | Suggested Solution |
---|---|---|
400 | Bad Request | Check request syntax and parameters. |
401 | Unauthorized | Validate authentication credentials. |
404 | Not Found | Confirm the endpoint URL. |
500 | Internal Server Error | Retry or contact technical support. |
📞 Support
For assistance, contact the Integration Services and Applications Coordination team.
📧 epalma@fgs.co
Last updated: April 2025